rustdoc-json: Structured attributes #142936

aDotInTheVoid · 2025-06-23T23:28:10Z

Implements and closes #141358.

This has 2 primary benefits.

For rustdoc-json consumers, they no longer need to parse strings of attributes, but it's there in a structured and normalized way. CC @obi1kenobi
For rustc conributors, the output of HIR pretty printing is no longer a versioned thing in the output. People can work on Tracking issue: Attribute refactor #131229 without needing to bump FORMAT_VERSION. CC @jdonszelmann @JonathanBrouwer.

(Over time, as the attribute refractor continues, I expect we'll add new things to rustdoc_json_types::Attribute. But this can be done separately to the rustc changes).

Todo before being mergable:

Update test assertions.
Fix modeling of #[repr].
~~Add tests of #[doc(hidden)] in Item::attrs (probably in a seperate PR).~~ I'm gonna punt this to a future PR
Documentation.

rustbot · 2025-06-23T23:28:15Z

r? @notriddle

rustbot has assigned @notriddle.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2025-06-23T23:28:18Z

rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing src/librustdoc/json/conversions.rs; otherwise, make sure you bump the FORMAT_VERSION constant.

cc @CraftSpider, @aDotInTheVoid, @Enselic, @obi1kenobi

jdonszelmann · 2025-06-23T23:35:46Z

Awesome alona! I'll take a proper look tomorrow <3

obi1kenobi

I like this!

In the near term cargo-semver-checks will have to internally re-stringify the attributes just for code compatibility with prior rustdoc JSON versions. But I look forward to the day when I can rip all that out and enjoy the structured form instead!

src/rustdoc-json-types/lib.rs

bors · 2025-06-24T05:47:03Z

☔ The latest upstream changes (presumably #142929) made this pull request unmergeable. Please resolve the merge conflicts.

src/rustdoc-json-types/lib.rs

rustbot · 2025-06-24T19:27:17Z

r? @GuillaumeGomez

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2025-06-24T19:27:18Z

These commits modify tests/rustdoc-json.
rustdoc-json is a public (but unstable) interface.

Please ensure that if you've changed the output:

It's intentional.
The FORMAT_VERSION in src/librustdoc-json-types is bumped if necessary.

cc @aDotInTheVoid, @obi1kenobi

aDotInTheVoid · 2025-06-24T19:28:16Z

Now no longer WIP.

When you're happy with it, let me know but don't r+, as I'll need to squash commits.

obi1kenobi

Very nice! Looking forward to this!

obi1kenobi · 2025-06-24T23:23:16Z

src/librustdoc/clean/types.rs

+                // NoMangle is special cased, as it's currently the only structured
+                // attribute that we want to appear in HTML output.


As a separate concern unrelated to this PR, perhaps HTML output should list both #[no_mangle] and #[export_name] in their edition 2024 form i.e. wrapped in unsafe?

Please open an issue then so it's not forgotten.

We already track this in #142835 (comment) (jana is assigned)

tests/rustdoc-json/attrs/must_use.rs

tests/rustdoc-json/attrs/repr_c_int_enum.rs

GuillaumeGomez

Changes look good to me. It's nice to see less is_json conditions in the common code. :)

bors · 2025-06-27T04:59:44Z

☔ The latest upstream changes (presumably #143074) made this pull request unmergeable. Please resolve the merge conflicts.

…istime, r=GuillaumeGomez rustdoc-json: Structured attributes Implements and closes rust-lang#141358. This has 2 primary benefits. 1. For rustdoc-json consumers, they no longer need to parse strings of attributes, but it's there in a structured and normalized way. CC `@obi1kenobi` 2. For rustc conributors, the output of HIR pretty printing is no longer a versioned thing in the output. People can work on rust-lang#131229 without needing to bump `FORMAT_VERSION`. CC `@jdonszelmann` `@JonathanBrouwer.` (Over time, as the attribute refractor continues, I expect we'll add new things to `rustdoc_json_types::Attribute`. But this can be done separately to the rustc changes). Todo before being mergable: - [x] Update test assertions. - [x] Fix modeling of `#[repr]`. - [ ] ~~Add tests of `#[doc(hidden)]` in `Item::attrs` (probably in a seperate PR).~~ I'm gonna punt this to a future PR - [x] Documentation.

Rollup of 12 pull requests Successful merges: - #142936 (rustdoc-json: Structured attributes) - #143355 (wrapping shift: remove first bitmask and table) - #143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`) - #143692 (miri: fix out-of-bounds error for ptrs with negative offsets) - #143719 (Emit warning when there is no space between `-o` and arg) - #143738 (Move several float tests to floats/mod.rs) - #143891 (Port `#[coverage]` to the new attribute system) - #143920 (Make more of codegen_llvm safe) - #143921 (Constify `Index` traits) - #143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.) - #143948 (Update mdbook to 0.4.52) - #143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`) r? `@ghost` `@rustbot` modify labels: rollup

…istime, r=GuillaumeGomez rustdoc-json: Structured attributes Implements and closes rust-lang#141358. This has 2 primary benefits. 1. For rustdoc-json consumers, they no longer need to parse strings of attributes, but it's there in a structured and normalized way. CC ``@obi1kenobi`` 2. For rustc conributors, the output of HIR pretty printing is no longer a versioned thing in the output. People can work on rust-lang#131229 without needing to bump `FORMAT_VERSION`. CC ``@jdonszelmann`` ``@JonathanBrouwer.`` (Over time, as the attribute refractor continues, I expect we'll add new things to `rustdoc_json_types::Attribute`. But this can be done separately to the rustc changes). Todo before being mergable: - [x] Update test assertions. - [x] Fix modeling of `#[repr]`. - [ ] ~~Add tests of `#[doc(hidden)]` in `Item::attrs` (probably in a seperate PR).~~ I'm gonna punt this to a future PR - [x] Documentation.

…bzol tidy: check for invalid file names Check for file names added to git with: - non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure) - control characters (such as "\n" or "\r" in file names) - ":" (which is a special character on Windows, made rust-lang#142936 fail in bors while it could have be caught earlier) It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in. r? jieyouxu as he stumbled upon such a file in rust-lang#142936

Rollup of 13 pull requests Successful merges: - #142936 (rustdoc-json: Structured attributes) - #143355 (wrapping shift: remove first bitmask and table) - #143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`) - #143692 (miri: fix out-of-bounds error for ptrs with negative offsets) - #143719 (Emit warning when there is no space between `-o` and arg) - #143738 (Move several float tests to floats/mod.rs) - #143920 (Make more of codegen_llvm safe) - #143921 (Constify `Index` traits) - #143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.) - #143948 (Update mdbook to 0.4.52) - #143957 (tidy: check for invalid file names) - #143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`) - #143990 (Add LocalKey<Cell>::update) r? `@ghost` `@rustbot` modify labels: rollup

…bzol tidy: check for invalid file names Check for file names added to git with: - non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure) - control characters (such as "\n" or "\r" in file names) - ":" (which is a special character on Windows, made rust-lang#142936 fail in bors while it could have be caught earlier) It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in. r? jieyouxu as he stumbled upon such a file in rust-lang#142936

Rollup of 12 pull requests Successful merges: - #142936 (rustdoc-json: Structured attributes) - #143355 (wrapping shift: remove first bitmask and table) - #143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`) - #143692 (miri: fix out-of-bounds error for ptrs with negative offsets) - #143738 (Move several float tests to floats/mod.rs) - #143920 (Make more of codegen_llvm safe) - #143921 (Constify `Index` traits) - #143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.) - #143948 (Update mdbook to 0.4.52) - #143957 (tidy: check for invalid file names) - #143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`) - #143990 (Add LocalKey<Cell>::update) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #143957 - samueltardieu:tidy-filenames, r=Kobzol tidy: check for invalid file names Check for file names added to git with: - non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure) - control characters (such as "\n" or "\r" in file names) - ":" (which is a special character on Windows, made #142936 fail in bors while it could have be caught earlier) It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in. r? jieyouxu as he stumbled upon such a file in #142936

Rollup merge of #142936 - aDotInTheVoid:rdj-shatts-forrealthistime, r=GuillaumeGomez rustdoc-json: Structured attributes Implements and closes #141358. This has 2 primary benefits. 1. For rustdoc-json consumers, they no longer need to parse strings of attributes, but it's there in a structured and normalized way. CC ```@obi1kenobi``` 2. For rustc conributors, the output of HIR pretty printing is no longer a versioned thing in the output. People can work on #131229 without needing to bump `FORMAT_VERSION`. CC ```@jdonszelmann``` ```@JonathanBrouwer.``` (Over time, as the attribute refractor continues, I expect we'll add new things to `rustdoc_json_types::Attribute`. But this can be done separately to the rustc changes). Todo before being mergable: - [x] Update test assertions. - [x] Fix modeling of `#[repr]`. - [ ] ~~Add tests of `#[doc(hidden)]` in `Item::attrs` (probably in a seperate PR).~~ I'm gonna punt this to a future PR - [x] Documentation.

tidy: check for invalid file names Check for file names added to git with: - non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure) - control characters (such as "\n" or "\r" in file names) - ":" (which is a special character on Windows, made rust-lang/rust#142936 fail in bors while it could have be caught earlier) It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in. r? jieyouxu as he stumbled upon such a file in rust-lang/rust#142936

Rollup of 12 pull requests Successful merges: - rust-lang/rust#142936 (rustdoc-json: Structured attributes) - rust-lang/rust#143355 (wrapping shift: remove first bitmask and table) - rust-lang/rust#143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`) - rust-lang/rust#143692 (miri: fix out-of-bounds error for ptrs with negative offsets) - rust-lang/rust#143738 (Move several float tests to floats/mod.rs) - rust-lang/rust#143920 (Make more of codegen_llvm safe) - rust-lang/rust#143921 (Constify `Index` traits) - rust-lang/rust#143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.) - rust-lang/rust#143948 (Update mdbook to 0.4.52) - rust-lang/rust#143957 (tidy: check for invalid file names) - rust-lang/rust#143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`) - rust-lang/rust#143990 (Add LocalKey<Cell>::update) r? `@ghost` `@rustbot` modify labels: rollup

See rust-lang/rust#142936. Closes cargo-public-api#805.

rustbot assigned notriddle Jun 23, 2025

aDotInTheVoid unassigned notriddle Jun 23, 2025

aDotInTheVoid marked this pull request as draft June 23, 2025 23:28

aDotInTheVoid mentioned this pull request Jun 23, 2025

Rework #[cold] attribute parser #142491

Merged

aDotInTheVoid added the A-attributes Area: Attributes (`#[…]`, `#![…]`) label Jun 23, 2025

This comment has been minimized.

Sign in to view

obi1kenobi reviewed Jun 24, 2025

View reviewed changes

src/rustdoc-json-types/lib.rs Outdated Show resolved Hide resolved

src/rustdoc-json-types/lib.rs Show resolved Hide resolved

src/rustdoc-json-types/lib.rs Show resolved Hide resolved

aDotInTheVoid mentioned this pull request Jun 24, 2025

rustdoc-json: Add test for #[optimize(..)] #142916

Merged

JonathanBrouwer reviewed Jun 24, 2025

View reviewed changes

src/rustdoc-json-types/lib.rs Show resolved Hide resolved

aDotInTheVoid changed the title ~~WIP: rustdoc-json: Structured attributes~~ rustdoc-json: Structured attributes Jun 24, 2025

aDotInTheVoid marked this pull request as ready for review June 24, 2025 19:27

rustbot assigned GuillaumeGomez Jun 24, 2025

rust-cloud-vms bot force-pushed the rdj-shatts-forrealthistime branch from 1d4b795 to c912543 Compare June 24, 2025 19:27

This comment has been minimized.

Sign in to view

obi1kenobi reviewed Jun 24, 2025

View reviewed changes

GuillaumeGomez approved these changes Jun 25, 2025

View reviewed changes

rust-cloud-vms bot force-pushed the rdj-shatts-forrealthistime branch 2 times, most recently from c5a697c to df1d953 Compare July 7, 2025 21:28

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Jul 15, 2025

samueltardieu mentioned this pull request Jul 15, 2025

Rollup of 12 pull requests #143983

Closed

samueltardieu mentioned this pull request Jul 16, 2025

Rollup of 13 pull requests #144017

Closed

samueltardieu mentioned this pull request Jul 16, 2025

Rollup of 12 pull requests #144028

Merged

bors merged commit 9f2015d into rust-lang:master Jul 16, 2025
11 checks passed

rustbot added this to the 1.90.0 milestone Jul 16, 2025

tamird added a commit to tamird/cargo-public-api that referenced this pull request Jul 17, 2025

Support nightly-2025-07-17 and later

f1da998

See rust-lang/rust#142936. Closes cargo-public-api#805.

tamird mentioned this pull request Jul 17, 2025

Support nightly-2025-07-17 and later cargo-public-api/cargo-public-api#807

Merged

tamird added a commit to tamird/cargo-public-api that referenced this pull request Jul 17, 2025

Support nightly-2025-07-17 and later

b72e52b

See rust-lang/rust#142936. Closes cargo-public-api#805.

		// NoMangle is special cased, as it's currently the only structured
		// attribute that we want to appear in HTML output.

rustdoc-json: Structured attributes #142936

rustdoc-json: Structured attributes #142936

Conversation

aDotInTheVoid commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Jun 23, 2025

Uh oh!

rustbot commented Jun 23, 2025

Uh oh!

jdonszelmann commented Jun 23, 2025

Uh oh!

This comment has been minimized.

obi1kenobi left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bors commented Jun 24, 2025

Uh oh!

Uh oh!

rustbot commented Jun 24, 2025

Uh oh!

rustbot commented Jun 24, 2025

Uh oh!

aDotInTheVoid commented Jun 24, 2025

Uh oh!

This comment has been minimized.

obi1kenobi left a comment

Choose a reason for hiding this comment

Uh oh!

obi1kenobi Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

fmease Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez left a comment

Choose a reason for hiding this comment

Uh oh!

bors commented Jun 27, 2025

Uh oh!

Uh oh!

Uh oh!

aDotInTheVoid commented Jun 23, 2025 •

edited

Loading

obi1kenobi left a comment •

edited

Loading